package br.com.it4.zmed.service;

import java.util.List;

import br.com.it4.framework.util.exception.BusinessException;
import br.com.it4.framework.util.exception.SystemException;
import br.com.it4.zmed.entity.Convenio;
import br.com.it4.zmed.filter.ConvenioFilter;

/**
 * Interface de acesso as funcionalidades de convenio.
 * 
 * @author Mozart Silva (mozart.vsilva@gmail.com)
 * 
 */
public interface ConvenioService {

    /**
     * Adiciona um determinado convenio.
     * 
     * @param convenio
     *            O convenio a ser adicionado.
     * @return O convenio adicionado.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     * @throws BusinessException
     *             Exceção caso ocorra erro na validação.
     */
    public Convenio addConvenio(Convenio convenio) throws SystemException, BusinessException;

    /**
     * Atualiza um determinado convenio.
     * 
     * @param convenio
     *            O convenio a ser atualizado.
     * @return O convenio atualizado.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     * @throws BusinessException
     *             Exceção caso ocorra erro na validação.
     */
    public Convenio updateConvenio(Convenio convenio) throws SystemException, BusinessException;

    /**
     * Remove um determinado convenio.
     * 
     * @param convenio
     *            O perfil a ser removido.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public void removeConvenio(Convenio convenio) throws SystemException;

    /**
     * Consulta um determinado convenio a partir da entidade.
     * 
     * @param codigo
     *            O codigo do convenio a ser consultado.
     * @return A lista de convenios.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public Convenio getConvenio(Long codigo) throws SystemException;

    /**
     * Consulta a lista de convenios.
     * 
     * @return A lista de convenios.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public List<Convenio> getConvenios() throws SystemException;

    /**
     * Consulta um determinado número de convenios a partir do filtro.
     * 
     * @param filtro
     *            Filtro para o convenio.
     * @param registroInicio
     *            O registro de inicio retornado.
     * @param registroFim
     *            O registro final retornado.
     * @return A lista de convenios.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public List<Convenio> getConvenios(ConvenioFilter filtro, int registroInicio, int registroFim)
            throws SystemException;

    /**
     * Calcula o número de registros de convenios a partir pelo filtro.
     * 
     * @param filtro
     *            Filtro para o convenio.
     * @return O número de registros encontrados.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public Long getConveniosCount(ConvenioFilter filtro) throws SystemException;

}